Inscoper::SubDeviceDescription¶

SubDeviceDescription class provides sub-device information coming from drivers. More...

#include <SubDeviceDescription.h>

Public Functions¶

	Name
	SubDeviceDescription() Default constructor.
const std::string &	getName() const Get the name of the sub-device.
void	setName(const std::string & name) Set the name of the sub-device.
std::vector< Inscoper::FunctionDescriptionPtr >	getFunctions() Get the function list of the sub-device.
Inscoper::FunctionDescriptionPtr	getFunction(Inscoper::EFunctionType type) Get the function corresponding to the given type.
void	setFunction(Inscoper::EFunctionType type, const Inscoper::FunctionDescriptionPtr & function) Set the function of the given type.
unsigned short	getTag() const Get the tag of the sub-device.
void	setTag(unsigned short tag) Set the tag of the sub-device.
const std::vector< Inscoper::ESubDeviceLabel > &	getLabelList() const get the label list of the sub-device.
void	addLabel(Inscoper::ESubDeviceLabel label) add a label to the sub-device.
bool	hasLabel(Inscoper::ESubDeviceLabel label) check if the sub-device has the label in param.
std::vector< unsigned short >	getParams() get the Param tag list of the sub-device : The list corresponds to the params needed for the declared functions.
bool	isPostInit() const Check if post-initialization is required.
void	setPostInit(bool postInit) Set post-initialization status.

Detailed Description¶

class Inscoper::SubDeviceDescription;

SubDeviceDescription class provides sub-device information coming from drivers.

This class stores details about a specific functional unit within a device (sub-device), such as its name, type, tag, and associated control functions.

Public Functions Documentation¶

function SubDeviceDescription¶

SubDeviceDescription()

Default constructor.

Initializes a new instance of the SubDeviceDescription class.

function getName¶

const std::string & getName() const

Get the name of the sub-device.

Return: The name of the sub-device

Retrieves the display name of the sub-device.

function setName¶

void setName(
    const std::string & name
)

Set the name of the sub-device.

Parameters:

name : The name of the sub-device

Sets the display name of the sub-device.

function getFunctions¶

std::vector< Inscoper::FunctionDescriptionPtr > getFunctions()

Get the function list of the sub-device.

Return: The list of functions of the sub-device

Retrieves all functions associated with this sub-device.

function getFunction¶

Inscoper::FunctionDescriptionPtr getFunction(
    Inscoper::EFunctionType type
)

Get the function corresponding to the given type.

Parameters:

type : The function's type

Return: The function if found, nullptr otherwise

Retrieves a specific function by its functional type.

function setFunction¶

void setFunction(
    Inscoper::EFunctionType type,
    const Inscoper::FunctionDescriptionPtr & function
)

Set the function of the given type.

Parameters:

type : The function's type
function : The function to set

Assigns a function to this sub-device for a specific functional type.

function getTag¶

unsigned short getTag() const

Get the tag of the sub-device.

Return: The tag of the sub-device

Retrieves the unique tag of the sub-device.

function setTag¶

void setTag(
    unsigned short tag
)

Set the tag of the sub-device.

Parameters:

tag : The tag of the sub-device

Sets the unique tag of the sub-device.

function getLabelList¶

const std::vector< Inscoper::ESubDeviceLabel > & getLabelList() const

get the label list of the sub-device.

Return: The label list of the sub-device

Retrieves the list of all labels associated to this sub-device.

function addLabel¶

void addLabel(
    Inscoper::ESubDeviceLabel label
)

add a label to the sub-device.

Parameters:

label : The label to add

Adds a label to be associated to this sub-device.

function hasLabel¶

bool hasLabel(
    Inscoper::ESubDeviceLabel label
)

check if the sub-device has the label in param.

Parameters:

label : the label to check

Return: True if the Sub Device has the label, false otherwise

Checks if a label is associated to this sub-device.

function getParams¶

std::vector< unsigned short > getParams()

get the Param tag list of the sub-device : The list corresponds to the params needed for the declared functions.

Return: The list of associated parameter tags

Retrieves the list of parameter tags required by the declared functions of this sub-device.

function isPostInit¶

bool isPostInit() const

Check if post-initialization is required.

Return: True if post-initialization is required, false otherwise

Determines whether this sub-device requires a post-initialization step.

function setPostInit¶

void setPostInit(
    bool postInit
)

Set post-initialization status.

Parameters:

postInit : True to enable post-initialization

Specifies whether this sub-device requires a post-initialization step.

Updated on 2026-06-23 at 10:35:20 +0200